/*
 * Copyright 2014 IBM Corp.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.ibm.spark.magic

/**
  * Represents the base structure for a magic that is loaded and executed.
  */
trait MagicTemplate {
   /**
    * Execute a magic representing a line magic.
    * @param code The single line of code
    * @return The output of the magic
    */
   def executeLine(code: String): MagicOutput

   /**
    * Execute a magic representing a cell magic.
    * @param code The list of code, separated by newlines
    * @return The output of the magic
    */
   def executeCell(code: Seq[String]): MagicOutput
 }
